Platform Explorer / Nuxeo Platform 2021.62

Operation Document.FetchByProperty (Fetch By Property)

Description

For each specified string property value, fetch all documents that match the property and the optional where clause. Matching documents are collected into a list and the returned to the next operation. The operation has no input.
Operation id Document.FetchByProperty
Category Fetch
Label Fetch By Property
Requires
Since

Parameters

Name Description Type Required Default value
property string yes  
values stringlist yes  
query string no  

Signature

Inputs void
Outputs documents

Implementation Information

Implementation Class Class: org.nuxeo.ecm.automation.core.operations.document.FetchByProperty
Contributing Component org.nuxeo.ecm.core.automation.coreContrib

JSON Definition

{
  "id" : "Document.FetchByProperty",
  "label" : "Fetch By Property",
  "category" : "Fetch",
  "requires" : null,
  "description" : "For each specified string property value, fetch all documents that match the property and the optional where clause. Matching documents are collected into a list and the returned to the next operation. The operation has no input.",
  "url" : "Document.FetchByProperty",
  "signature" : [ "void", "documents" ],
  "params" : [ {
    "name" : "property",
    "description" : null,
    "type" : "string",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "values",
    "description" : null,
    "type" : "stringlist",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  }, {
    "name" : "query",
    "description" : null,
    "type" : "string",
    "required" : false,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}